<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Strict//EN">
<html>

<head>
<meta http-equiv="Content-Language" content="en-us">
<title>simAdjustView</title>
<link rel="stylesheet" type="text/css" href="../../style.css">
</head>

<body>

<div align="center">
<table class=allEncompassingTable >
 <tr>
  <td >
<p><a href="../../index.html" TARGET="_top"><img src="../images/homeImg.png"></a></p>

<h1>Regular API function</h1>
<h3 class=subsectionBar><a name="simAdjustView" id="simAdjustView"></a>simAdjustView / sim.adjustView </h3>
<table class=apiTable>
<tr class=apiTableTr> 
<td class=apiTableLeftDescr>
Description 
</td> 
<td class=apiTableRightDescr>Adjusts parameters of a view. See also the <a href="simFloatingViewAdd.htm">sim.floatingViewAdd</a> and <a href="simCameraFitToView.htm">sim.cameraFitToView</a> functions.<br></td>
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftCSyn>
C synopsis
</td> 
<td class=apiTableRightCSyn>simInt simAdjustView(simInt viewHandleOrIndex,simInt associatedViewableObjectHandle,simInt options,const simChar* viewLabel)<br></td> 
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftCParam>C parameters</td> 
<td class=apiTableRightCParam>
<div><strong>viewHandleOrIndex</strong>: the handle of the view (can also be a floating view), or the index of the view.</div>
<div><strong>associatedViewableObjectHandle</strong>: handle of the object that you wish to associate with the view. Must be a viewable object. Can also be -1, in which case the view is emptied<br>
</div>
<div><strong>options</strong>: bit-coded:</div>
<div class=tab><strong>bit0-bit3</strong>=the 3D display mode (0=solid rendering, 1=wireframe rendering)<br>
</div>
<div class=tab><strong>bit4 (16)</strong> set=orthogonal projection (otherwise perspective projection)<br>
</div>
<div class=tab><strong>bit5 (32)</strong> set=x/y graph display (otherwise time-graph display)</div>
<div class=tab><strong>bit6 (64)</strong> set=floating view is removed at simulation end</div>
<div class=tab><strong>bit7 (128)</strong> set=floating view is ignored during a scene save operation</div>
<div class=tab><strong>bit8 (256)</strong> set=the view is not modified. The return value of the function indicates if the view still exists (2), or does not exist anymore (1). No error is generated.</div>
<div class=tab><strong>bit9 (512)</strong> set=the view is not modified. The return value of the function represents the object associated with the view.</div>
<div class=tab><strong>bit10 (1024)</strong> set=x/y graph has x view size proportional to y view size.</div>
<div><strong>viewLabel</strong>: a label that will be displayed at the top of a floating view. If nullptr is specified, then the name of the associated viewable object is taken as label.<br>
</div>
<div></div>
</td> 
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftCRet>
C return value
</td> 
<td class=apiTableRightCRet>
<div>A value &gt;0 in case of success</div>
</td> 
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftLSyn>
Lua synopsis
</td> 
<td class=apiTableRightLSyn>int result=sim.adjustView(int viewHandleOrIndex,int associatedViewableObjectHandle,int options,string viewLabel=nil)<br></td> 
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftLParam>Lua parameters</td> 
<td class=apiTableRightLParam>
<div>Similar to the C-function counterpart</div>
<div></div></td> 
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftLRet>
Lua return values
</td> 
<td class=apiTableRightLRet>
<div>Similar to the C-function counterpart</div>
<div></div></td> 
</tr> 
</table> 


<br>
</td>
</tr>
</table>
</div>
</body>
</html>
